home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-04 / dhhelper.zip / README.DOC < prev    next >
Text File  |  1990-06-01  |  5KB  |  129 lines
  1. A) DESCRIPTION OF THE PROGRAM
  2. ==============================
  3.  
  4.   The Helper v3.2 - Creating Help screens and hypertext files
  5.   ------------------------------------------------------------
  6.  
  7.   With The Helper you can create hypertext-like programs and help files
  8.   with the following features:
  9.  
  10.     *  a "Help file" is created from an ASCII text file, and this Help file
  11.        is then compiled into an interactive hypertext document. The compiled
  12.        file can be used as an interactive information document where various
  13.        topics can be selected using the arrow keys and a cursor bar, or it
  14.        can become a controlling program in its own right, or a combination
  15.        of both.
  16.   
  17.     *  each Help file can have up to 254 categories of information, with up
  18.        to 254 pages per category (though the shareware version is limited to
  19.        a total of 24 pages). Use PgUp and PgDn to page up and down within a
  20.        category, or flip between pages and categories using highlighted
  21.        cursor options;
  22.  
  23.     *  backtrack through previously-selected categories;
  24.  
  25.     *  animate the screens by using time-delay overlays;
  26.  
  27.     *  search for text;
  28.  
  29.     *  print some or all of the Help screens;
  30.  
  31.     *  the window size and position can be individually set for each page,
  32.        with full color control on each page;
  33.  
  34.     *  auto-sensing of color or mono video cards, to set colors accordingly
  35.        (separate color sets can be specified for color or mono cards);
  36.  
  37.     *  cursor actions can be programmed to execute specific DOS commands, or
  38.        enter a DOS shell (these features let you create sophisticated menu
  39.        programs, auto-installation routines, etc).
  40.  
  41.     *  The Helper itself contains masses of help screens to guide you through
  42.        all the features and aspects of the program while you develop your own
  43.        applications.
  44.  
  45.     *  several sample Help files are supplied to demonstrate most of the
  46.        features of The Helper.
  47.  
  48.   In addition, if you are adding the Help to your Turbo Pascal programs,
  49.   you can have:
  50.  
  51.     *  entry from your program into any specific category of the Help file
  52.        (for context-sensitive help) or automatic entry into the most recent
  53.        category used;
  54.  
  55.     *  exit and re-entry for your own user-specific functions, which can be
  56.        activated either by global "hot keys" or from a cursor bar within
  57.        the document. These user functions could be anything from sounding
  58.        the bell to running another application, returning to the controlling
  59.        Help file on completion.
  60.  
  61.   Note that you do NOT require Turbo Pascal to use The Helper. However, if
  62.   you are a Turbo Pascal programmer you can incorporate access to your
  63.   compiled Help files directly into your programs. Several sample Turbo Pascal
  64.   programs are supplied to demonstrate how easy it is to do this. In its
  65.   simplest application only 2 or 3 lines of source code are required for full
  66.   access to a Help file for your program, including all the features listed
  67.   above.
  68.  
  69.  
  70. B) LIMITATIONS
  71. ===============
  72.  
  73.   The shareware version of The Helper is limited to a total of 24 pages
  74.   per Help file. The full version supplied to registered users can have
  75.   up to 2000 pages, and even this limit can be exceeded if necessary.
  76.  
  77.  
  78. C) REQUIREMENTS
  79. ================
  80.  
  81.   Required:  IBM-PC or compatible.
  82.  
  83.  
  84. D) LIST OF PROGRAM FILES
  85. =========================
  86.  
  87.   go      .bat    Start-up and installation batch file
  88.   go      .txt    Text file used by go.bat
  89.   helper  .bat    Batch file for running The Helper
  90.   helper  .exe    The Helper program
  91.   helper-s.hlp    Help file for helper.exe
  92.   usehelp .exe    Program for using your own Help files
  93.   install .hlp    Help file used for installing The Helper
  94.   animate .hls    Animation demonstration text file for The Helper
  95.   demo?   .hls    More demonstration text files
  96.   demo?   .pas    Demonstration Turbo Pascal programs
  97.   dosshell.tpu    Turbo Pascal 4 unit
  98.   help    .tpu    Turbo Pascal 4 unit
  99.   library .tpu    Turbo Pascal 4 unit
  100.   readme  .doc    Read this file first
  101.   catalog .doc    Program description, for a catalogue listing.
  102.  
  103.  
  104. E) REGISTRATION
  105. ================
  106.  
  107.   Registration is US$38-00 or Aus$50-00.
  108.  
  109.  
  110. F) HOW TO START THE PROGRAM
  111. ============================
  112.  
  113.   Type GO for a guided installation onto a hard disk, or..
  114.   Copy all files to your hard disk if you have one. You can run from
  115.   a floppy disk if you need to, but disk operations will be slower.
  116.  
  117.   The program automatically detects color or mono video cards and sets
  118.   some of the colors accordingly. So if you have a color video card with
  119.   a mono screen some of the colors may seem strange, or invisible. If that
  120.   happens, use the command-line parameter /M to force the use of the mono
  121.   color set.   ie. type   HELPER /M    at the DOS prompt.
  122.  
  123.   The program is normally started by typing:
  124.   HELPER     (press Enter) at the DOS prompt.
  125.  
  126.   Command-line parameters can be added:
  127.   HELPER [fn] [/M]      fn = filename to edit,  /M = force mono colors.
  128.  
  129.